path-exists

What is path-exists?

The path-exists npm package is used to check if a file or directory exists on the file system without using fs.existsSync. It is built on top of Node.js's fs.promises API and provides a simple promise-based interface.

What are path-exists's main functionalities?

Check if a path exists

This feature allows you to check if a file or directory exists asynchronously by returning a promise that resolves to either true or false.

const pathExists = require('path-exists');

(async () => {
  const exists = await pathExists('/path/to/file');
  console.log(exists);
  //=> true or false
})();

Check if a path exists synchronously

This feature provides a synchronous way to check if a file or directory exists, returning a boolean value immediately.

const pathExists = require('path-exists');

const exists = pathExists.sync('/path/to/file');
console.log(exists);
//=> true or false

Other packages similar to path-exists

fs-extra

fs-extra is a package that extends the built-in fs module, providing additional methods and ensuring consistency across platforms. It includes the 'pathExists' and 'pathExistsSync' methods, which are similar to the functionality provided by path-exists. fs-extra offers a broader set of file system operations, making it a more comprehensive choice for file system interactions.

make-dir

make-dir is a package that focuses on creating directories and their parent directories if they don't exist. While it doesn't provide a direct method to check for the existence of a path, it is related in the sense that it handles the existence of directories as part of its operation. It differs from path-exists as it is more about directory creation than existence checking.

README

path-exists

Check if a path exists

NOTE: fs.existsSync has been un-deprecated in Node.js since 6.8.0. If you only need to check synchronously, this module is not needed.

While fs.exists() is being deprecated, there's still a genuine use-case of being able to check if a path exists for other purposes than doing IO with it.

Never use this before handling a file though:

In particular, checking if a file exists before opening it is an anti-pattern that leaves you vulnerable to race conditions: another process may remove the file between the calls to fs.exists() and fs.open(). Just open the file and handle the error when it's not there.

Install

$ npm install path-exists

Usage

// foo.js
const pathExists = require('path-exists');

(async () => {
	console.log(await pathExists('foo.js'));
	//=> true
})();

API

pathExists(path)

Returns a Promise<boolean> of whether the path exists.

pathExists.sync(path)

Returns a boolean of whether the path exists.

Related

• path-exists-cli - CLI for this module

License

MIT © Sindre Sorhus